Clarify frontmatter requirements in contributing-skills.md#38
Conversation
CONTRIBUTING-SKILLS.md
Outdated
| ``` | ||
|
|
||
| That's it. No frontmatter required. No code. No config. Just instructions in markdown. | ||
| Every SKILL.md needs YAML frontmatter with a `name` and `description` so the plugin system can discover it: |
There was a problem hiding this comment.
I'm going to push back on "needs" here.
Here's a working example with no frontmatter: unit-test-generator/SKILL.md — it registers fine as /pf-react:unit-test-generator:
Skills are discovered by directory path, not frontmatter. A description is important — but it can just be the first line of the SKILL.md, it doesn't need to be in YAML frontmatter. And name is redundant since the directory name is the skill name.
There was a problem hiding this comment.
Hm, when I first tried to use my skill without adding the frontmatter claude couldn't find it or this unit-test-generator skill 🤔
There was a problem hiding this comment.
How were you trying to find it exactly? Maybe you could demonstrate this. I don't mind making it a requirement - but it seems its not at least in terms of Claude Code discovery.
There was a problem hiding this comment.
Looking into this more - the skills npm package (a 3rd party tool) does not discover skills unless they have a "name" - so that's an incentive here at least. Also, the Claude code official docs do cite it - linked to slash command usage - https://code.claude.com/docs/en/skills. So I think this is enough to just make it a requirement for us.
|
The existing skill |
…unit-test-generator Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
wise-king-sullyman
deleted the
clarify-frontmatter-requirements-in-skills
branch
2 participants
Closes #37
Assisted by Claude Code